home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / dev / gcc / gcc263_doc.lha / gnu / man / man1 / sh.1 < prev    next >
Text File  |  1994-12-19  |  41KB  |  782 lines

  1.  
  2.  
  3.  sh(C)                         06 January 1993                          sh(C)
  4.  
  5.  
  6.  _N_a_m_e
  7.  
  8.     sh - invoke the shell command interpreter
  9.  
  10.  _S_y_n_t_a_x
  11.  
  12.     sshh [ --aacceeiikknnrrssttuuvvxx ] [ _aa_rr_gg_ss ]
  13.  
  14.  _D_e_s_c_r_i_p_t_i_o_n
  15.  
  16.     The shell is the standard command programming language that executes com-
  17.     mands read from a terminal or a file.  See ``Invocation'' below for the
  18.     meaning of arguments to the shell.
  19.  
  20.     _C_o_m_m_a_n_d_s
  21.  
  22.     A _s_i_m_p_l_e-_c_o_m_m_a_n_d is a sequence of nonblank _w_o_r_d_s separated by _b_l_a_n_k_s (a
  23.     _b_l_a_n_k is a tab or a space).  The first word specifies the name of the
  24.     command to be executed.  Except as specified below, the remaining words
  25.     are passed as arguments to the invoked command.  The command name is
  26.     passed as argument 0 (see eexxeecc(S)).  The _v_a_l_u_e of a simple-command is its
  27.     exit status if it terminates normally, or (octal) 1000+_ss_tt_aa_tt_uu_ss if it ter-
  28.     minates abnormally. See ssiiggnnaall(S) for a list of status values.
  29.  
  30.     A _p_i_p_e_l_i_n_e is a sequence of one or more _c_o_m_m_a_n_d_s separated by a vertical
  31.     bar (||).  (The caret (^^), is an obsolete synonym for the vertical bar and
  32.     should not be used in a pipeline.  Scripts that use ``^'' for pipelines
  33.     are incompatible with the Korn shell.)  The standard output of each com-
  34.     mand but the last is connected by a ppiippee(S) to the standard input of the
  35.     next command.  Each command is run as a separate process; the shell waits
  36.     for the last command to terminate.
  37.  
  38.     A _l_i_s_t is a sequence of one or more pipelines separated by ;;, &&, &&&&, or
  39.     ||||, and optionally terminated by ;; or &&.  Of these four symbols, ;; and &&
  40.     have equal precedence, which is lower than that of &&&& and ||||.  The sym-
  41.     bols &&&& and |||| also have equal precedence.  A semicolon (;;) causes
  42.     sequential execution of the preceding pipeline; an ampersand (&&) causes
  43.     asynchronous execution of the preceding pipeline (that is, the shell does
  44.     _n_o_t wait for that pipeline to finish).  The symbol &&&& (||||) causes the
  45.     _l_i_s_t following it to be executed only if the preceding pipeline returns a
  46.     zero (nonzero) exit status.  An arbitrary number of newlines may appear
  47.     in a _l_i_s_t, instead of semicolons, to delimit commands.
  48.  
  49.     A _c_o_m_m_a_n_d is either a simple-command or one of the following commands.
  50.     Unless otherwise stated, the value returned by a command is that of the
  51.     last simple-command executed in the command:
  52.  
  53.     ffoorr _nn_aa_mm_ee [ iinn _ww_oo_rr_dd ... ]
  54.     ddoo
  55.             _ll_ii_ss_tt
  56.     ddoonnee
  57.  
  58.     Each time a ffoorr command is executed, _nn_aa_mm_ee is set to the next _ww_oo_rr_dd taken
  59.     from the iinn _ww_oo_rr_dd list.  If iinn _ww_oo_rr_dd is omitted, then the ffoorr command exe-
  60.     cutes the ddoo _ll_ii_ss_tt once for each positional parameter that is set (see
  61.     ``Parameter substitution'' below).  Execution ends when there are no more
  62.     words in the list.
  63.  
  64.  
  65.     ccaassee _ww_oo_rr_dd iinn
  66.     [ _pp_aa_tt_tt_ee_rr_nn [ | _pp_aa_tt_tt_ee_rr_nn ] ... )) _ll_ii_ss_tt
  67.                                     ;;;; ]
  68.     eessaacc
  69.  
  70.     A ccaassee command executes the _ll_ii_ss_tt associated with the first _pp_aa_tt_tt_ee_rr_nn that
  71.     matches _ww_oo_rr_dd.  The form of the patterns is the same as that used for
  72.     filename generation (see ``Filename generation'' below).
  73.  
  74.  
  75.     iiff _ll_ii_ss_tt
  76.     tthheenn
  77.             _ll_ii_ss_tt
  78.     [ eelliiff _ll_ii_ss_tt tthheenn
  79.             _ll_ii_ss_tt ]
  80.     ...
  81.     [ eellssee _ll_ii_ss_tt ]
  82.     ffii
  83.  
  84.     The _ll_ii_ss_tt following iiff is executed and, if it returns a zero exit status,
  85.     the _ll_ii_ss_tt following the first tthheenn is executed.  Otherwise, the _ll_ii_ss_tt fol-
  86.     lowing eelliiff is executed and, if its value is zero, the _ll_ii_ss_tt following the
  87.     next tthheenn is executed.  Failing that, the eellssee _ll_ii_ss_tt is executed.  If no
  88.     eellssee _ll_ii_ss_tt or tthheenn _ll_ii_ss_tt is executed, then the iiff command returns a zero
  89.     exit status.
  90.  
  91.  
  92.     wwhhiillee _ll_ii_ss_tt
  93.     ddoo
  94.             _ll_ii_ss_tt
  95.     ddoonnee
  96.  
  97.     A wwhhiillee command repeatedly executes the wwhhiillee _ll_ii_ss_tt and, if the exit
  98.     status of the last command in the list is zero, executes the ddoo _ll_ii_ss_tt;
  99.     otherwise the loop terminates.  If no commands in the ddoo _ll_ii_ss_tt are exe-
  100.     cuted, then the wwhhiillee command returns a zero exit status; uunnttiill may be
  101.     used in place of wwhhiillee to negate the loop termination test.
  102.  
  103.  
  104.     uunnttiill _ll_ii_ss_tt
  105.     ddoo
  106.             _ll_ii_ss_tt
  107.     ddoonnee
  108.  
  109.     uunnttiill is similar to wwhhiillee, only uunnttiill continues execution until the first
  110.     _ll_ii_ss_tt returns a zero exit status.  In other words, uunnttiill works until the
  111.     test condition succeeds (it works the whole time the command is failing);
  112.     wwhhiillee works until the test condition fails. uunnttiill is useful when you are
  113.     waiting for a particular event to occur.
  114.  
  115.  
  116.     ((_ll_ii_ss_tt))
  117.  
  118.     Executes _ll_ii_ss_tt in a subshell.
  119.  
  120.  
  121.     {{_ll_ii_ss_tt;;}}
  122.  
  123.     _ll_ii_ss_tt is simply executed.
  124.  
  125.  
  126.     _nn_aa_mm_ee (()) {{_ll_ii_ss_tt;;}}
  127.  
  128.     Define a function which is referenced by _nn_aa_mm_ee.  The body of functions is
  129.     the _ll_ii_ss_tt of commands between {{ and }}.  Execution of functions is
  130.     described later (see ``Execution''.)
  131.  
  132.     The following words are recognized only as the first word of a command
  133.     and when not quoted:
  134.  
  135.     iiff      tthheenn    eellssee    eelliiff    ffii      ccaassee    eessaacc
  136.     ffoorr     wwhhiillee   uunnttiill   ddoo      ddoonnee    {{       }}
  137.  
  138.     _C_o_m_m_e_n_t_s
  139.  
  140.     A word beginning with ## causes that word and all the following characters
  141.     up to a newline to be ignored.
  142.  
  143.     _C_o_m_m_a_n_d _s_u_b_s_t_i_t_u_t_i_o_n
  144.  
  145.     The standard output from a command enclosed between grave accents ( `` `` )
  146.     may be used as part or all of a word; trailing newlines are removed.
  147.  
  148.     No interpretation is done on the command string before the string is
  149.     read, except to remove backslashes (\\) used to escape other characters.
  150.     Backslashes may be used to escape grave accents (``) or other backslashes
  151.     and are removed before the command string is read.  Escaping grave
  152.     accents allows nested command substitution.  If the command substitution
  153.     lies within a pair of double quotes ( "" `` ...... `` "" ), backslashes used to
  154.     escape a double quote (\\"") will be removed; otherwise, they will be left
  155.     intact.
  156.  
  157.     If a backslash is used to escape a newline character, both the backslash
  158.     and the newline are removed (see the section on ``Quoting'').  In addi-
  159.     tion, backslashes used to escape dollar signs ( \\$$ ) are removed.  Since
  160.     no interpretation is done on the command string before it is read,
  161.     inserting a backslash to escape a dollar sign has no effect.  Backslashes
  162.     that precede characters other than \\, ``, "", nneewwlliinnee, and $$ are left
  163.     intact.
  164.  
  165.     _P_a_r_a_m_e_t_e_r _s_u_b_s_t_i_t_u_t_i_o_n
  166.  
  167.     The character $$ is used to introduce substitutable _p_a_r_a_m_e_t_e_r_s.  There are
  168.     two types of parameters, positional and keyword.  If _p_a_r_a_m_e_t_e_r is a
  169.     digit, it is a positional parameter. Positional parameters may be
  170.     assigned values by sseett.  Keyword parameters, (also known as variables)
  171.     may be assigned values by writing:
  172.  
  173.        _nn_aa_mm_ee _== _vv_aa_ll_uu_ee [ _nn_aa_mm_ee _== _vv_aa_ll_uu_ee ] ...
  174.  
  175.     Pattern-matching is not performed on _vv_aa_ll_uu_ee.  There cannot be a function
  176.     and a variable with the same name.
  177.  
  178.     $${{_pp_aa_rr_aa_mm_ee_tt_ee_rr}}
  179.          A _pp_aa_rr_aa_mm_ee_tt_ee_rr is a sequence of letters, digits, or underscores (a
  180.          _n_a_m_e), a digit, or any of the characters **, @@, ##, ??, --, $$, and !!.
  181.          The value, if any, of the parameter is substituted.  The braces are
  182.          required only when _pp_aa_rr_aa_mm_ee_tt_ee_rr is followed by a letter, digit, or
  183.          underscore that is not to be interpreted as part of its name.  A
  184.          _n_a_m_e must begin with a letter or underscore.  If _pp_aa_rr_aa_mm_ee_tt_ee_rr is a
  185.          digit then it is a positional parameter.  If _pp_aa_rr_aa_mm_ee_tt_ee_rr is ** or @@,
  186.          then all the positional parameters, starting with $$11, are substi-
  187.          tuted (separated by spaces).  Parameter $$00 is set from argument zero
  188.          when the shell is invoked.
  189.  
  190.     $${{_pp_aa_rr_aa_mm_ee_tt_ee_rr::--_ww_oo_rr_dd}}
  191.          If _pp_aa_rr_aa_mm_ee_tt_ee_rr is set and is not a null argument, substitute its
  192.          value; otherwise substitute _ww_oo_rr_dd.
  193.  
  194.     $${{_pp_aa_rr_aa_mm_ee_tt_ee_rr::==_ww_oo_rr_dd}}
  195.          If _pp_aa_rr_aa_mm_ee_tt_ee_rr is not set or is null, then set it to _ww_oo_rr_dd; the value
  196.          of the parameter is then substituted.  Positional parameters may not
  197.          be assigned to in this way.
  198.  
  199.     $${{_pp_aa_rr_aa_mm_ee_tt_ee_rr::??_ww_oo_rr_dd}}
  200.          If _pp_aa_rr_aa_mm_ee_tt_ee_rr is set and is not a null argument, substitute its
  201.          value; otherwise, print _ww_oo_rr_dd and exit from the shell.  If _ww_oo_rr_dd is
  202.          omitted, the message ``parameter null or not set'' is printed.
  203.  
  204.     $${{_pp_aa_rr_aa_mm_ee_tt_ee_rr::++_ww_oo_rr_dd}}
  205.          If _pp_aa_rr_aa_mm_ee_tt_ee_rr is set and is not a null argument, substitute _ww_oo_rr_dd;
  206.          otherwise substitute nothing.
  207.  
  208.     In the above, _ww_oo_rr_dd is not evaluated unless it is to be used as the sub-
  209.     stituted string, so that in the following example, ppwwdd is executed only
  210.     if dd is not set or is null:
  211.  
  212.        eecchhoo  $${{dd::--((ggaappwwdd``}}
  213.  
  214.     If the colon (::) is omitted from the above expressions, then the shell
  215.     only checks whether _pp_aa_rr_aa_mm_ee_tt_ee_rr is set.
  216.  
  217.     The following parameters are automatically set by the shell:
  218.  
  219.     ##    The number of positional parameters in decimal
  220.  
  221.     --    Flags supplied to the shell on invocation or by the sseett command
  222.  
  223.     ??    The decimal value returned by the last synchronously executed com-
  224.          mand
  225.  
  226.     $$    The process number of this shell
  227.  
  228.     !!    The process number of the last background command invoked
  229.  
  230.     The following parameters are used by the shell:
  231.  
  232.     CCDDPPAATTHH        Defines search path for the ccdd command.  See the section
  233.                   ``cd'' under ``Special commands'' below.
  234.  
  235.     HHOOMMEE          The default argument (home directory) for the ccdd command
  236.  
  237.     PPAATTHH          The search path for commands (see ``Execution'' below)
  238.  
  239.     MMAAIILL          If this variable is set to the name of a mail file, then
  240.                   the shell informs the user of the arrival of mail in the
  241.                   specified file
  242.  
  243.     MMAAIILLCCHHEECCKK     This parameter specifies how often (in seconds) the shell
  244.                   will check for the arrival of mail in the files specified
  245.                   by the MMAAIILLPPAATTHH or MMAAIILL parameters.  The default value is
  246.                   600 seconds (10 minutes).  If set to 0, the shell will
  247.                   check before each prompt.
  248.  
  249.     MMAAIILLPPAATTHH      A colon ((::)) separated list of filenames.  If this parameter
  250.                   is set, the shell informs the user of the arrival of mail
  251.                   in any of the specified files.  Each filename can be fol-
  252.                   lowed by ``%'' and a message that will be printed when the
  253.                   modification time changes.  The default message is
  254.                   ``you have mail''.
  255.  
  256.     PPSS11           Primary prompt string, by default ``$$ ''
  257.  
  258.     PPSS22           Secondary prompt string, by default ``>> ''
  259.  
  260.     IIFFSS           Internal field separators, normally ssppaaccee, ttaabb, and nneewwlliinnee
  261.  
  262.     SSHHEELLLL         When the shell is invoked, it scans the environment (see
  263.                   ``Environment'' below) for this name.  If it is found and
  264.                   there is an `r' in the file name part of its value, the
  265.                   shell becomes a restricted shell.
  266.  
  267.     The shell gives default values to PPAATTHH, PPSS11, PPSS22, and IIFFSS, while HHOOMMEE and
  268.     MMAAIILL are not set at all by the shell (although HHOOMMEE _i_s set by llooggiinn(M)).
  269.  
  270.     _B_l_a_n_k _i_n_t_e_r_p_r_e_t_a_t_i_o_n
  271.  
  272.     After parameter and command substitution, the results of substitution are
  273.     scanned for internal field separator characters (those found in IIFFSS) and
  274.     split into distinct arguments where such characters are found.  Explicit
  275.     null arguments ( """" or '''' ) are retained.  Implicit null arguments (those
  276.     resulting from _pp_aa_rr_aa_mm_ee_tt_ee_rr_ss that have no values) are removed.
  277.  
  278.     _F_i_l_e_n_a_m_e _g_e_n_e_r_a_t_i_o_n
  279.  
  280.     Following substitution, each command _ww_oo_rr_dd is scanned for the characters
  281.     **, ??, and [[.  If one of these characters appears, the word is regarded as
  282.     a _pp_aa_tt_tt_ee_rr_nn.  The word is replaced with alphabetically sorted filenames
  283.     that match the pattern.  If no filename is found that matches the pat-
  284.     tern, the word is left unchanged.  The character ``.'' at the start of a
  285.     filename or immediately following a ``/'', as well as the character ``/''
  286.     itself, must be matched explicitly. These characters and their matching
  287.     patterns are:
  288.  
  289.     **     Matches any string, including the null string.
  290.  
  291.     ??     Matches any single character.
  292.  
  293.     [[...]] Matches any one of the enclosed characters.  A pair of characters
  294.           separated by ``-'' matches any character lexically between the
  295.           pair, inclusive.  If the first character following the opening
  296.           bracket ([[) is an exclamation mark (!!), then any character not
  297.           enclosed is matched.
  298.  
  299.     _Q_u_o_t_i_n_g
  300.  
  301.     The following characters have a special meaning to the shell and cause
  302.     termination of a word unless quoted:
  303.  
  304.        ;  &  (  )  |  ^  <  >  newline  space  tab
  305.  
  306.     A character may be _q_u_o_t_e_d (that is, made to stand for itself) by preced-
  307.     ing it with a ``\''.  The pair \\nneewwlliinnee is ignored.  All characters
  308.     enclosed between a pair of single quotation marks ('' ''), except a single
  309.     quotation mark, are quoted.  Inside double quotation marks ("" ""), parame-
  310.     ter and command substitution occurs and ``\'' quotes the characters \\, ``,
  311.     "", and $$.  ""$$**"" is equivalent to ""$$11 $$22 ..."", whereas ""$$@@"" is equivalent
  312.     to ""$$11"" ""$$22"" ...
  313.  
  314.     _P_r_o_m_p_t_i_n_g
  315.  
  316.     When used interactively, the shell prompts with the value of PPSS11 before
  317.     reading a command.  If at any time a newline is typed and further input
  318.     is needed to complete a command, the secondary prompt (that is, the value
  319.     of PPSS22) is issued.
  320.  
  321.     _S_p_e_l_l_i_n_g _c_h_e_c_k_e_r
  322.  
  323.     When using ccdd(C) the shell checks spelling.  For example, if you change
  324.     to a different directory using ccdd and misspell the directory name, the
  325.     shell responds with an alternative spelling of an existing directory.
  326.     Enter ``y'' and press <Return> (or just press <Return>) to change to the
  327.     offered directory.  If the offered spelling is incorrect, enter ``n'',
  328.     then retype the command line.  In this example the sshh(C) response is
  329.     boldfaced:
  330.  
  331.        $ cd /usr/spol/uucp
  332.        ccdd //uussrr//ssppooooll//uuuuccpp??y
  333.        ookk
  334.  
  335.  
  336.     _I_n_p_u_t/_O_u_t_p_u_t
  337.  
  338.     Before a command is executed, its input and output may be redirected
  339.     using a special notation interpreted by the shell.  The following may
  340.     appear anywhere in a simple-command or may precede or follow a command.
  341.     They are _n_o_t passed on to the invoked command; substitution occurs before
  342.     _ww_oo_rr_dd or _dd_ii_gg_ii_tt is used:
  343.  
  344.     <<_ww_oo_rr_dd         Use file _ww_oo_rr_dd as standard input (file descriptor 0).
  345.  
  346.     >>_ww_oo_rr_dd         Use file _ww_oo_rr_dd as standard output (file descriptor 1).  If
  347.                   the file does not exist, it is created; otherwise, it is
  348.                   truncated to zero length.
  349.  
  350.     >>>>_ww_oo_rr_dd        Use file _ww_oo_rr_dd as standard output.  If the file exists, out-
  351.                   put is appended to it (by first seeking the end-of-file);
  352.                   otherwise, the file is created.
  353.  
  354.     <<<<[--]_ww_oo_rr_dd     The shell input is read up to a line that is the same as
  355.                   _ww_oo_rr_dd, or to an end-of-file.  The resulting document becomes
  356.                   the standard input.  If any character of _ww_oo_rr_dd is quoted, no
  357.                   interpretation is placed upon the characters of the docu-
  358.                   ment; otherwise, parameter and command substitution occurs,
  359.                   (unescaped) \\nneewwlliinnee is ignored, and ``\'' must be used to
  360.                   quote the characters \\, $$, ``, and the first character of
  361.                   _ww_oo_rr_dd.  If ``-'' is appended to <<<<, all leading tabs are
  362.                   stripped from _ww_oo_rr_dd and from the document.
  363.  
  364.     <<&&_dd_ii_gg_ii_tt       The standard input is duplicated from file descriptor _dd_ii_gg_ii_tt
  365.                   (see dduupp(S)).  Similarly for the standard output using >>.
  366.  
  367.     <<&&--           The standard input is closed.  Similarly for the standard
  368.                   output using >>.
  369.  
  370.     If one of the above is preceded by a digit, the file descriptor created
  371.     is that specified by the digit (instead of the default 0 or 1).  For
  372.     example:
  373.  
  374.        ...... 22>>&&11
  375.  
  376.     creates file descriptor 2 that is a duplicate of file descriptor 1.
  377.  
  378.     If a command is followed by ``&'', the default standard input for the
  379.     command is the empty file /_d_e_v/_n_u_l_l.  Otherwise, the environment for the
  380.     execution of a command contains the file descriptors of the invoking
  381.     shell as modified by input/output specifications.
  382.  
  383.     _E_n_v_i_r_o_n_m_e_n_t
  384.  
  385.     The _e_n_v_i_r_o_n_m_e_n_t (see eennvviirroonn(M)) is a list of name-value pairs that is
  386.     passed to an executed program in the same way as a normal argument list.
  387.     The shell interacts with the environment in several ways.  On invocation,
  388.     the shell scans the environment and creates a parameter for each name
  389.     found, giving it the corresponding value.  Executed commands inherit the
  390.     same environment.  If the user modifies the values of these parameters or
  391.     creates new ones, none of these affect the environment unless the eexxppoorrtt
  392.     command is used to bind the shell's parameter to the environment.  The
  393.     environment seen by any executed command is composed of any unmodified
  394.     name-value pairs originally inherited by the shell, minus any pairs
  395.     removed by uunnsseett, plus any modifications or additions, all of which must
  396.     be noted in eexxppoorrtt commands.
  397.  
  398.     The environment for any _s_i_m_p_l_e-_c_o_m_m_a_n_d may be augmented by prefixing it
  399.     with one or more assignments to parameters.  Thus:
  400.  
  401.        TTEERRMM==wwyy6600 _cc_mm_dd _aa_rr_gg_ss
  402.  
  403.     and
  404.  
  405.        (eexxppoorrtt TTEERRMM; TTEERRMM==wwyy6600; _cc_mm_dd _aa_rr_gg_ss)
  406.  
  407.     are equivalent (as far as the above execution of _cc_mm_dd is concerned).
  408.  
  409.     If the --kk flag is set, _a_l_l keyword arguments are placed in the environ-
  410.     ment, even if they occur after the command name.
  411.  
  412.     _S_i_g_n_a_l_s
  413.  
  414.     The IINNTTEERRRRUUPPTT and QQUUIITT signals for an invoked command are ignored if the
  415.     command is followed by ``&''; otherwise signals have the values inherited
  416.     by the shell from its parent, with the exception of signal 11.  See the
  417.     ttrraapp command below.
  418.  
  419.     _E_x_e_c_u_t_i_o_n
  420.  
  421.     Each time a command is executed, the above substitutions are carried out.
  422.     If the command name does not match a _s_p_e_c_i_a_l _c_o_m_m_a_n_d, but matches the
  423.     name of a defined function, the function is executed in the shell process
  424.     (note how this differs from the execution of shell procedures). The posi-
  425.     tional parameters $$11,, $$22, ... are set to the arguments of the function.
  426.     If the command name matches neither a _s_p_e_c_i_a_l _c_o_m_m_a_n_d nor the name of a
  427.     defined function, a new process is created and an attempt is made to exe-
  428.     cute the command via eexxeecc(S).
  429.  
  430.     The shell parameter PPAATTHH defines the search path for the directory con-
  431.     taining the command.  Alternative directory names are separated by a
  432.     colon (::).  The default path is :/_b_i_n:/_u_s_r/_b_i_n (specifying the current
  433.     directory, /_b_i_n, and /_u_s_r/_b_i_n, in that order).  Note that the current
  434.     directory is specified by a null pathname, which can appear immediately
  435.     after the equal sign or between the colon delimiters anywhere else in the
  436.     path list.  If the command name contains a ``/'', then the search path is
  437.     not used.  Otherwise, each directory in the path is searched for an exe-
  438.     cutable file.  If the file has execute permission but is not an _a._o_u_t
  439.     file, it is assumed to be a file containing shell commands.  A subshell
  440.     (that is, a separate process) is spawned to read it.  A parenthesized
  441.     command is also executed in a subshell.
  442.  
  443.     Shell procedures are often used by users running the ccsshh.  However, if
  444.     the first character of the procedure is a ``#'' (comment character), ccsshh
  445.     assumes the procedure is a ccsshh script, and invokes //bbiinn//ccsshh to execute
  446.     it. Always start sshh procedures with some other character if ccsshh users are
  447.     to run the procedure at any time.  This invokes the standard shell
  448.     //bbiinn//sshh.
  449.  
  450.     The location in the search path where a command was found is remembered
  451.     by the shell (to help avoid unnecessary eexxeeccs later).  If the command was
  452.     found in a relative directory, its location must be re-determined when-
  453.     ever the current directory changes.  The shell forgets all remembered
  454.     locations whenever the PPAATTHH variable is changed or the hhaasshh --rr command is
  455.     executed (see hhaasshh in next section).
  456.  
  457.     _S_p_e_c_i_a_l _c_o_m_m_a_n_d_s
  458.  
  459.     Input/output redirection is permitted for these commands:
  460.  
  461.     ::    No effect; the command does nothing.  A zero exit code is returned.
  462.  
  463.     .. _ff_ii_ll_ee
  464.          Reads and executes commands from _ff_ii_ll_ee and returns.  The search path
  465.          specified by PPAATTHH is used to find the directory containing _ff_ii_ll_ee.
  466.  
  467.     bbrreeaakk [ _nn ]
  468.          Exits from the enclosing ffoorr, wwhhiillee, or uunnttiill loop, if any.  If _nn is
  469.          specified, it breaks _nn levels.
  470.  
  471.     ccoonnttiinnuuee [ _nn ]
  472.          Resumes the next iteration of the enclosing ffoorr, wwhhiillee, or uunnttiill
  473.          loop.  If _nn is specified, it resumes at the _nn-th enclosing loop.
  474.  
  475.     ccdd [ _aa_rr_gg ]
  476.          Changes the current directory to _aa_rr_gg.  The shell parameter HHOOMMEE is
  477.          the default _aa_rr_gg.  The shell parameter CCDDPPAATTHH defines the search path
  478.          for the directory containing _aa_rr_gg.  Alternative directory names are
  479.          separated by a colon (:).  The default path is <null> (specifying
  480.          the current directory).  Note that the current directory is speci-
  481.          fied by a null path name, which can appear immediately after the
  482.          equal sign or between the colon delimiters anywhere else in the path
  483.          list.  If _aa_rr_gg begins with a ``/'', the search path is not used.
  484.          Otherwise, each directory in the path is searched for _aa_rr_gg.
  485.  
  486.          If the shell is reading its commands from a terminal, and the speci-
  487.          fied directory does not exist (or some component cannot be
  488.          searched), spelling correction is applied to each component of
  489.          _d_i_r_e_c_t_o_r_y, in a search for the ``correct'' name.  The shell then
  490.          asks whether or not to try and change directory to the corrected
  491.          directory name; an answer of nn means ``no'', and anything else is
  492.          taken as ``yes''.
  493.  
  494.     eecchhoo [ _aa_rr_gg ]
  495.          Writes arguments separated by blanks and terminated by a newline on
  496.          the standard output.  Arguments may be enclosed in quotes.  Quotes
  497.          are required so that the shell correctly interprets these special
  498.          escape sequences:
  499.  
  500.          \\bb      Backspace
  501.          \\cc      Prints line without newline.
  502.          \\ff      Form feed
  503.          \\nn      Newline
  504.          \\rr      Carriage return
  505.          \\tt      Tab
  506.          \\vv      Vertical tab
  507.          \\\\      Backslash
  508.          \\_nn      The 8-bit character whose ASCII code is the 1, 2 or 3-digit
  509.                  octal number _nn.  _nn must start with a zero.
  510.  
  511.  
  512.     eevvaall [ _aa_rr_gg ... ]
  513.          The arguments are read as input to the shell and the resulting
  514.          command(s) executed.
  515.  
  516.     eexxeecc [ _aa_rr_gg ... ]
  517.          The command specified by the arguments is executed in place of this
  518.          shell without creating a new process.  Input/output arguments may
  519.          appear and, if no other arguments are given, cause the shell
  520.          input/output to be modified.
  521.  
  522.     eexxiitt [ _nn ]
  523.          Causes the shell to exit with the exit status specified by _nn.  If _nn
  524.          is omitted, the exit status is that of the last command executed.
  525.          An end-of-file will also cause the shell to exit.
  526.  
  527.     eexxppoorrtt [ _nn_aa_mm_ee ... ]
  528.          The given _nn_aa_mm_ees are marked for automatic export to the _e_n_v_i_r_o_n_m_e_n_t
  529.          of subsequently executed commands.  If no arguments are given, a
  530.          list of all names that are exported in this shell is printed.
  531.  
  532.     ggeettooppttss
  533.          Used in shell scripts to support command syntax standards (see
  534.          IInnttrroo(C)); it parses positional parameters and checks for legal
  535.          options.  See ggeettooppttss(C) for usage and description.
  536.  
  537.     hhaasshh [ --rr ] [ _nn_aa_mm_ee ... ]
  538.          For each _nn_aa_mm_ee, the location in the search path of the command speci-
  539.          fied by _nn_aa_mm_ee is determined and remembered by the shell.  The --rr
  540.          option causes the shell to forget all remembered locations.  If no
  541.          arguments are given, information about remembered commands is
  542.          presented.  ``Hits'' is the number of times a command has been
  543.          invoked by the shell process.  ``Cost'' is a measure of the work
  544.          required to locate a command in the search path.  There are certain
  545.          situations which require that the stored location of a command be
  546.          recalculated.  Commands for which this will be done are indicated by
  547.          an asterisk (**) adjacent to the ``hits'' information.  ``Cost'' will
  548.          be incremented when the recalculation is done.
  549.  
  550.     nneewwggrrpp [ _aa_rr_gg ... ]
  551.          Equivalent to eexxeecc nneewwggrrpp _aa_rr_gg ...
  552.  
  553.     ppwwdd  Print the current working directory.  See ppwwdd(C) for usage and
  554.          description.
  555.  
  556.     rreeaadd [ _nn_aa_mm_ee ... ]
  557.          One line is read from the standard input and the first word is
  558.          assigned to the first _nn_aa_mm_ee, the second word to the second _nn_aa_mm_ee,
  559.          etc., with leftover words assigned to the last _nn_aa_mm_ee.  The return
  560.          code is 0 unless an end-of-file is encountered.
  561.  
  562.     rreeaaddoonnllyy [ _nn_aa_mm_ee ... ]
  563.          The given _nn_aa_mm_ees are marked rreeaaddoonnllyy and the values of these _nn_aa_mm_ees
  564.          may not be changed by subsequent assignment.  If no arguments are
  565.          given, a list of all rreeaaddoonnllyy names is printed.
  566.  
  567.     rreettuurrnn [ _nn ]
  568.          Causes a function to exit with the return value specified by _nn.  If
  569.          _nn is omitted, the return status is that of the last command
  570.          executed.
  571.  
  572.     sseett [ --aaeeffhhkknnuuvvxx [ _aa_rr_gg ... ] ]
  573.  
  574.          --aa  Mark variables which are modified or created for export.
  575.          --ee  If the shell is noninteractive, exits immediately if a command
  576.              exits with a nonzero exit status.
  577.          --ff  Disables filename generation.
  578.          --hh  Locates and remembers function commands as functions are defined
  579.              (function commands are normally located when the function is
  580.              executed).  For example, if hh is set, /_b_i_n/_t_t_y is added to the
  581.              hash table when:
  582.  
  583.              showtty(){
  584.                  tty
  585.              }
  586.  
  587.              is declared. If hh is unset, the function is not added to the
  588.              hash table until showtty is called.
  589.          --kk  Places all keyword arguments in the environment for a command,
  590.              not just those that precede the command name.
  591.          --nn  Reads commands but does not execute them.
  592.          --uu  Treats unset variables as an error when substituting.
  593.          --vv  Prints shell input lines as they are read.
  594.          --xx  Prints commands and their arguments as they are executed.
  595.              Although this flag is passed to subshells, it does not enable
  596.              tracing in those subshells.
  597.          ----  Does not change any of the flags; useful in setting $1 to ``-''.
  598.  
  599.              Using ``+'' rather than ``-'' causes these flags to be turned
  600.              off.  These flags can also be used upon invocation of the shell.
  601.              The current set of flags may be found in $$--.  The remaining
  602.              arguments are positional parameters and are assigned, in order,
  603.              to $$11, $$22, ...  If no arguments are given, the values of all
  604.              names are printed.
  605.  
  606.     sshhiifftt [_nn]
  607.          The positional parameters from $$22 ...  are renamed $$11 ... If _nn is
  608.          specified, shift the positional parameters by _nn places. sshhiifftt is the
  609.          only way to access positional parameters above $$99.
  610.  
  611.     tteesstt Evaluates conditional expressions. See tteesstt(C) for usage and
  612.          description.
  613.  
  614.     ttiimmeess
  615.          Prints the accumulated user and system times for processes run from
  616.          the shell.
  617.  
  618.     ttrraapp [ _aa_rr_gg ] [ _nn ] ...
  619.          _aa_rr_gg is a command to be read and executed when the shell receives
  620.          signal(s) _nn.  (Note that _aa_rr_gg is scanned once when the trap is set
  621.          and once when the trap is taken.)  Trap commands are executed in
  622.          order of signal number.  The highest signal number allowed is 16.
  623.          Any attempt to set a trap on a signal that was ignored on entry to
  624.          the current shell is ineffective.  An attempt to trap on signal 11
  625.          (memory fault) produces an error.  If _aa_rr_gg is absent, all trap(s) _nn
  626.          are reset to their original values.  If _aa_rr_gg is the null string, this
  627.          signal is ignored by the shell and by the commands it invokes.  If _nn
  628.          is 0, the command _aa_rr_gg is executed on exit from the shell.  The ttrraapp
  629.          command with no arguments prints a list of commands associated with
  630.          each signal number.
  631.  
  632.     ttyyppee [ _nn_aa_mm_ee ... ]
  633.          For each _nn_aa_mm_ee, indicate how it would be interpreted if used as a
  634.          command name.
  635.  
  636.     uulliimmiitt [ _nn ]
  637.          imposes a size limit of _nn blocks on files written by the shell and
  638.          its child processes (files of any size may be read). Any user may
  639.          decrease the file size limit, but only the super user (_r_o_o_t) can
  640.          increase the limit.  With no argument, the current limit is printed.
  641.          If no option is given and a number is specified, --ff is assumed.
  642.  
  643.     uunnsseett [ _nn_aa_mm_ee ... ]
  644.          For each _nn_aa_mm_ee, remove the corresponding variable or function.  The
  645.          variables PPAATTHH, PPSS11, PPSS22, MMAAIILLCCHHEECCKK and IIFFSS cannot be unset.
  646.  
  647.     uummaasskk [ _oo_oo_oo ]
  648.          The user file-creation mask is set to the octal number _oo_oo_oo where _oo
  649.          is an octal digit (see uummaasskk(C)).  If _oo_oo_oo is omitted, the current
  650.          value of the mask is printed.
  651.  
  652.     wwaaiitt [ _nn ]
  653.          Waits for the specified process to terminate, and reports the termi-
  654.          nation status.  If _nn is not given, all currently active child pro-
  655.          cesses are waited for.  The return code from this command is always
  656.          0.
  657.  
  658.     _I_n_v_o_c_a_t_i_o_n
  659.  
  660.     If the shell is invoked through eexxeecc(S) and the first character of argu-
  661.     ment 0 is ``-'', commands are initially read from /_e_t_c/_p_r_o_f_i_l_e and then
  662.     from $$HHOOMMEE/._p_r_o_f_i_l_e, if such files exist.  Thereafter, commands are read
  663.     as described below, which is also the case when the shell is invoked as
  664.     //bbiinn//sshh.  The flags below are interpreted by the shell on invocation
  665.     only; note that unless the --cc or --ss flag is specified, the first argument
  666.     is assumed to be the name of a file containing commands, and the remain-
  667.     ing arguments are passed as positional parameters to that command file:
  668.  
  669.     --cc _ss_tt_rr_ii_nn_gg If the --cc flag is present, commands are read from _ss_tt_rr_ii_nn_gg.
  670.  
  671.     --ss        If the --ss flag is present or if no arguments remain, commands
  672.               are read from the standard input.  Any remaining arguments
  673.               specify the positional parameters.  Shell output is written to
  674.               file descriptor 2.
  675.  
  676.     --tt        If the --tt flag is present, a single command is read and exe-
  677.               cuted, and the shell exits.  This flag is intended for use by C
  678.               programs only and is not useful interactively.
  679.  
  680.     --ii        If the --ii flag is present or if the shell input and output are
  681.               attached to a terminal, this shell is _i_n_t_e_r_a_c_t_i_v_e.  In this
  682.               case, TTEERRMMIINNAATTEE is ignored (so that kkiillll 00 does not kill an
  683.               interactive shell) and IINNTTEERRRRUUPPTT is caught and ignored (so that
  684.               wwaaiitt is interruptible).  In all cases, QQUUIITT is ignored by the
  685.               shell.
  686.  
  687.     --rr        If the --rr flag is present, the shell is a restricted shell (see
  688.               rrsshh(C)).
  689.  
  690.     The remaining flags and arguments are described under the sseett command
  691.     above.
  692.  
  693.  _E_x_i_t _s_t_a_t_u_s
  694.  
  695.     Errors detected by the shell, such as syntax errors, cause the shell to
  696.     return a nonzero exit status.  If the shell is being used noninterac-
  697.     tively, execution of the shell file is abandoned.  Otherwise, the shell
  698.     returns the exit status of the last command executed. See the eexxiitt com-
  699.     mand above.
  700.  
  701.  _F_i_l_e_s
  702.  
  703.     /_e_t_c/_p_r_o_f_i_l_e   system default _p_r_o_f_i_l_e, read by login shells before
  704.                    $$HHOOMMEE/._p_r_o_f_i_l_e
  705.     $$HHOOMMEE/._p_r_o_f_i_l_e read by login shell at login
  706.     /_t_m_p/_s_h*       temporary file for <<<<
  707.     /_d_e_v/_n_u_l_l      source of empty file
  708.  
  709.  _S_e_e _a_l_s_o
  710.  
  711.     aa..oouutt(FP), ccdd(C), dduupp(S), eennvv(C), eennvviirroonn(M), eexxeecc(S), ffoorrkk(S), kksshh(C),
  712.     llooggiinn(M), nneewwggrrpp(C), ppiippee(S), pprrooffiillee(M), rrsshh(C), ssiiggnnaall(S), tteesstt(C),
  713.     uummaasskk(C), uummaasskk(S) and wwaaiitt(S).
  714.  
  715.  _N_o_t_e_s
  716.  
  717.     The command rreeaaddoonnllyy (without arguments) produces the same type of output
  718.     as the command eexxppoorrtt.
  719.  
  720.     If <<<< is used to provide standard input to an asynchronous process
  721.     invoked by &&, the shell gets mixed up about naming the input document; a
  722.     garbage file /_t_m_p/_s_h* is created and the shell complains about not being
  723.     able to find that file by another name.
  724.  
  725.     If a command is executed, and a command with the same name is installed
  726.     in a directory in the search path before the directory where the original
  727.     command was found, the shell will continue to eexxeecc the original command.
  728.     Use the hhaasshh command to correct this situation.
  729.  
  730.     If you move the current directory or one above it, ppwwdd may not give the
  731.     correct response.  Use the ccdd command with a full pathname to correct
  732.     this situation.
  733.  
  734.     When a sshh user logs in, the system reads and executes commands in
  735.     /_e_t_c/_p_r_o_f_i_l_e before executing commands in the user's $$HHOOMMEE/._p_r_o_f_i_l_e.  You
  736.     can, therefore, modify the environment for all sshh users on the system by
  737.     editing /_e_t_c/_p_r_o_f_i_l_e.
  738.  
  739.     The shell doesn't treat the high (eighth) bit in the characters of a com-
  740.     mand line argument specially, nor does it strip the eighth bit from the
  741.     characters of error messages.  Previous versions of the shell used the
  742.     eighth bit as a quoting mechanism.
  743.  
  744.     Existing programs that set the eighth bit of characters in order to quote
  745.     them as part of the shell command line should be changed to use of the
  746.     standard shell quoting mechanisms (see the section on ``Quoting'').
  747.  
  748.     Words used to specify filenames in input/output redirection are not
  749.     expanded for filename generation (see the section on ``Filename
  750.     generation'').  For example, ccaatt ffiillee11 >> aa** will create a file named _a*.
  751.  
  752.     Because commands in pipelines are run as separate processes, variables
  753.     set in a pipeline have no effect on the parent shell.
  754.  
  755.     If you get the error message:
  756.  
  757.        fork failed - too many processes
  758.  
  759.     try using the wwaaiitt(C) command to clean up your background processes.  If
  760.     this doesn't help, the system process table is probably full or you have
  761.     too many active foreground processes (there is a limit to the number of
  762.     processes that be can associated with your login, and the number the sys-
  763.     tem can keep track of).
  764.  
  765.  _W_a_r_n_i_n_g_s
  766.  
  767.     Not all processes of a 3 or more stage pipeline are children of the
  768.     shell, and thus cannot be waited for.
  769.  
  770.     For wwaaiitt _nn, if _nn is not an active process id, all your shell's currently
  771.     active background processes are waited for and the return code will be
  772.     zero.
  773.  
  774.  _S_t_a_n_d_a_r_d_s _c_o_n_f_o_r_m_a_n_c_e
  775.  
  776.     sshh is conformant with:
  777.  
  778.     AT&T SVID Issue 2;
  779.     and X/Open Portability Guide, Issue 3, 1989.
  780.  
  781.  
  782.